Crate watchexec_events

watchexec-events

Watchexec’s event types.

• API documentation.
• Licensed under Apache 2.0 or MIT.
• Status: maintained.

Fundamentally, events in watchexec have three purposes:

1. To trigger the launch, restart, or other interruption of a process;
2. To be filtered upon according to whatever set of criteria is desired;
3. To carry information about what caused the event, which may be provided to the process.

Outside of Watchexec, this library is particularly useful if you’re building a tool that runs under it, and want to easily read its events (with --emit-events-to=json-file and --emit-events-to=json-stdio).

use std::io::{stdin, Result};
use watchexec_events::Event;

fn main() -> Result<()> {
    for line in stdin().lines() {
        let event: Event = serde_json::from_str(&line?)?;
        dbg!(event);
    }

    Ok(())
}

Features

• serde: enables serde support.
• notify: use Notify’s file event types (default).

If you disable notify, you’ll get a leaner dependency tree that’s still able to parse the entire events, but isn’t type compatible with Notify. In most deserialisation usecases, this is fine, but it’s not the default to avoid surprises.

Modules

• filekind
  Re-export of the Notify file event types.

Structs

• Event
  An event, as far as watchexec cares about.

Enums

• FileType
  The type of a file.
• Keyboard
  A keyboard input.
• Priority
  The priority of the event in the queue.
• ProcessEnd
  The end status of a process.
• Source
  The general origin of the event.
• Tag
  Something which can be used to filter or qualify an event.